feat(cactus-core-api): add ISendRequestResultV1<T> for Fujitsu verifier #2724
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
petermetz
requested review from
takeutak,
izuru0,
jagpreetsinghsasan,
VRamakrishna and
sandeepnRES
as code owners
petermetz
force-pushed
the
issue-x1-fujitsu-i-send-request-result-v1_t
branch
from
3fe5346
to
9e51c7f
Compare
izuru0
approved these changes
Oct 11, 2023
An interface representing the response object of the send sync and send async request methods on the connection-chain verifier API. Also great when trying to help bridge the gap between the API returning results as `unknown` and the tests needing auto-completion for the properties to assert for type of data at runtime. @see {ISocketApiClient<BlockType>} @see {Verifier<LedgerApiType extends ISocketApiClient<unknown>>} @see {IVerifier} [skip ci] Signed-off-by: Peter Somogyvari <[email protected]>
1. Changes the ISocketApiClient and the Verifier type definitions so that instead of `any` they are heavily relying on `unknown` which helps spotting bugs in the code where type checks should be done at runtime but currently aren't. 2. It also helps with spotting breaking changes in the future because if the test cases stop compiling it means you've done a breaking API change, but they'll always compile if the parameters and the return values are using `any` for their own types. 3. I've updated a big chunk of the test cases to have explicit type casts onto the shapes that are needed for them to compile (without changing any of the runtime behavior). 4. Also made it so that the json2str function of the DriverCommon code file now accepts unknown instead of object type which makes one of the linter warnings go away as well. Signed-off-by: Peter Somogyvari <[email protected]>
petermetz
force-pushed
the
issue-x1-fujitsu-i-send-request-result-v1_t
branch
from
9e51c7f
to
068d36d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An interface representing the response object of the send sync and send async
request methods on the connection-chain verifier API.
Also great when trying to help bridge the gap between the API returning
results as
unknownand the tests needing auto-completion for the propertiesto assert for type of data at runtime.
@see {ISocketApiClient}
@see {Verifier<LedgerApiType extends ISocketApiClient>}
@see {IVerifier}
Signed-off-by: Peter Somogyvari [email protected]
refactor(core-api,verifier-client): use unknown instead of any type
Changes the ISocketApiClient and the Verifier type definitions so that
instead of
anythey are heavily relying onunknownwhich helps spottingbugs in the code where type checks should be done at runtime but currently
aren't.
It also helps with spotting breaking changes in the future because if
the test cases stop compiling it means you've done a breaking API change,
but they'll always compile if the parameters and the return values are
using
anyfor their own types.I've updated a big chunk of the test cases to have explicit type casts
onto the shapes that are needed for them to compile (without changing
any of the runtime behavior).
Also made it so that the json2str function of the DriverCommon
code file now accepts unknown instead of object type which makes one of
the linter warnings go away as well.
Signed-off-by: Peter Somogyvari [email protected]